feat: add nudge braze email using commands #388

brobro10000 · 2024-01-18T17:04:37Z

Creates a command to send nudge emails to accepted assignments that are 14 and 30 days in advance for only executive education courses.

brobro10000 · 2024-01-22T19:35:46Z

enterprise_access/apps/content_assignments/constants.py

@@ -104,7 +104,7 @@ class AssignmentAutomaticExpiredReason:
    """
    Reason for assignment automatic expiry.
    """
-    NIENTY_DAYS_PASSED = 'NIENTY_DAYS_PASSED'
+    NINETY_DAYS_PASSED = 'NINETY_DAYS_PASSED'


Noticed a typo in this constant, refactored all cases where its used with the correct spelling for the value and variable

...prise_access/apps/content_assignments/management/commands/automatically_nudge_assignments.py

enterprise_access/apps/content_assignments/utils.py

...prise_access/apps/content_assignments/management/commands/automatically_nudge_assignments.py

...s/apps/content_assignments/management/commands/tests/test_automatically_nudge_assignments.py

...prise_access/apps/content_assignments/management/commands/automatically_nudge_assignments.py

...s/apps/content_assignments/management/commands/tests/test_automatically_nudge_assignments.py

iloveagent57 · 2024-01-23T19:53:06Z

You want to filter for only allocated assignments. accepted means they've already redeemed/enrolled.

This is the main thing to fix (plus tests) and the reason for requesting changes.

iloveagent57 · 2024-01-23T19:56:44Z

Ah, I misunderstood the intent here. The fact that we're sending reminders made me think you wanted allocated assignments. But you actually do want accepted ones. Let's take this conv off github for now, I think there's some nuance here.

iloveagent57

This is looking really good!

iloveagent57 · 2024-01-29T19:58:16Z

enterprise_access/apps/api/serializers/content_assignments/assignment.py

+class LearnerContentAssignmentNudgeRequestSerializer(serializers.Serializer):
+    """
+    Request serializer to validate nudge endpoint query params.
+
+    For view: LearnerContentAssignmentAdminViewSet.nudge
+    """
+    assignment_uuids = serializers.ListField(
+        child=serializers.UUIDField(),
+        allow_empty=False
+    )
+    days_before_course_start_date = serializers.IntegerField(
+        min_value=1
+    )
+
+
+class LearnerContentAssignmentNudgeResponseSerializer(serializers.Serializer):
+    """
+    Response serializer for nudge endpoint.
+
+    For view: LearnerContentAssignmentAdminViewSet.nudge
+    """
+    nudged_assignment_uuids = serializers.ListField(
+        child=serializers.UUIDField(),
+    )
+    unnudged_assignment_uuids = serializers.ListField(
+        child=serializers.UUIDField(),
+    )
+
+


enterprise_access/apps/api/v1/views/content_assignments/assignments_admin.py

enterprise_access/apps/content_assignments/api.py

enterprise_access/apps/content_assignments/content_metadata_api.py

...prise_access/apps/content_assignments/management/commands/automatically_nudge_assignments.py

...s/apps/content_assignments/management/commands/tests/test_automatically_nudge_assignments.py

iloveagent57

Approved, but please address that **kwargs thing before merging. 👍

iloveagent57 · 2024-01-30T20:20:48Z

enterprise_access/apps/api/v1/views/content_assignments/assignments_admin.py

+    @extend_schema(
+        tags=[CONTENT_ASSIGNMENT_ADMIN_CRUD_API_TAG],
+        summary='Nudge assignments by UUID.',
+        request=LearnerContentAssignmentNudgeRequestSerializer,
+        parameters=None,
+        responses={
+            status.HTTP_200_OK: LearnerContentAssignmentNudgeResponseSerializer,
+            status.HTTP_422_UNPROCESSABLE_ENTITY: None,
+        }
+    )
+    @permission_required(CONTENT_ASSIGNMENT_ADMIN_WRITE_PERMISSION, fn=assignment_admin_permission_fn)
+    @action(detail=False, methods=['post'])
+    def nudge(self, request, *args, **kwargs):
+        """
+        Send nudges to a list of learners with associated ``LearnerContentAssignment``
+        record by list of uuids.
+
+        ```
+        Raises:
+            400 If assignment_uuids list length is 0 or the value for days_before_course_start_date is less than 1
+            422 If the nudge_assignments call fails for any other reason
+        ```
+        """
+        serializer = LearnerContentAssignmentNudgeRequestSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+        assignment_configuration_uuid = self.requested_assignment_configuration_uuid
+        assignments = self.get_queryset().filter(
+            assignment_configuration__uuid=assignment_configuration_uuid,
+            uuid__in=serializer.data['assignment_uuids'],
+        )
+        days_before_course_start_date = serializer.data['days_before_course_start_date']
+        try:
+            result = assignments_api.nudge_assignments(
+                assignments,
+                assignment_configuration_uuid,
+                days_before_course_start_date
+            )
+            response_serializer = LearnerContentAssignmentNudgeResponseSerializer(data=result)
+            response_serializer.is_valid(raise_exception=True)
+            return Response(data=response_serializer.data, status=status.HTTP_200_OK)
+        except Exception:  # pylint: disable=broad-except
+            return Response(status=status.HTTP_422_UNPROCESSABLE_ENTITY)


This is a really, really well-factored and well-documented view, with really clear validation and abstractions around our business logic. Nice work, hang this on your fridge!

enterprise_access/apps/content_assignments/content_metadata_api.py

macdiesel

brobro10000 force-pushed the hu/ent-8166 branch 9 times, most recently from 9fa20d4 to fc242fb Compare January 22, 2024 19:34

brobro10000 commented Jan 22, 2024

View reviewed changes

brobro10000 force-pushed the hu/ent-8166 branch 2 times, most recently from e8ece62 to af3d2ed Compare January 22, 2024 19:51

brobro10000 marked this pull request as ready for review January 22, 2024 19:55

brobro10000 force-pushed the hu/ent-8166 branch 5 times, most recently from 5cba6e6 to c62d751 Compare January 23, 2024 17:16

feat: add nudge braze email using commands

c735a39

brobro10000 force-pushed the hu/ent-8166 branch from c62d751 to c735a39 Compare January 23, 2024 17:24

iloveagent57 requested changes Jan 23, 2024

View reviewed changes

brobro10000 force-pushed the hu/ent-8166 branch 5 times, most recently from 55c6222 to 456b4e5 Compare January 25, 2024 16:02

chore: PR feedback

03ff109

brobro10000 force-pushed the hu/ent-8166 branch from 456b4e5 to 03ff109 Compare January 25, 2024 16:08

brobro10000 force-pushed the hu/ent-8166 branch 8 times, most recently from c11dcf9 to 4c9dba8 Compare January 29, 2024 18:58

feat: Nudge API

e1d2c2d

brobro10000 force-pushed the hu/ent-8166 branch from 4c9dba8 to e1d2c2d Compare January 29, 2024 19:20

iloveagent57 reviewed Jan 29, 2024

View reviewed changes

brobro10000 force-pushed the hu/ent-8166 branch 3 times, most recently from 11a2d75 to 5e9d818 Compare January 30, 2024 08:34

chore: PR feedback 2

197af37

brobro10000 force-pushed the hu/ent-8166 branch from 5e9d818 to 197af37 Compare January 30, 2024 18:05

brobro10000 requested a review from iloveagent57 January 30, 2024 19:30

iloveagent57 approved these changes Jan 30, 2024

View reviewed changes

brobro10000 force-pushed the hu/ent-8166 branch 7 times, most recently from 8949677 to 8ccb407 Compare January 31, 2024 15:31

chore: Additional logging and exception handling

937d012

brobro10000 force-pushed the hu/ent-8166 branch from 8ccb407 to 937d012 Compare January 31, 2024 15:32

macdiesel approved these changes Jan 31, 2024

View reviewed changes

brobro10000 merged commit c1a4ad6 into main Jan 31, 2024
4 checks passed

brobro10000 deleted the hu/ent-8166 branch January 31, 2024 15:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add nudge braze email using commands #388

feat: add nudge braze email using commands #388

brobro10000 commented Jan 18, 2024 •

edited

Loading

brobro10000 Jan 22, 2024

iloveagent57 commented Jan 23, 2024 •

edited

Loading

iloveagent57 commented Jan 23, 2024

iloveagent57 left a comment

iloveagent57 Jan 29, 2024

iloveagent57 left a comment

iloveagent57 Jan 30, 2024

macdiesel left a comment

feat: add nudge braze email using commands #388

feat: add nudge braze email using commands #388

Conversation

brobro10000 commented Jan 18, 2024 • edited Loading

brobro10000 Jan 22, 2024

Choose a reason for hiding this comment

iloveagent57 commented Jan 23, 2024 • edited Loading

iloveagent57 commented Jan 23, 2024

iloveagent57 left a comment

Choose a reason for hiding this comment

iloveagent57 Jan 29, 2024

Choose a reason for hiding this comment

iloveagent57 left a comment

Choose a reason for hiding this comment

iloveagent57 Jan 30, 2024

Choose a reason for hiding this comment

macdiesel left a comment

Choose a reason for hiding this comment

brobro10000 commented Jan 18, 2024 •

edited

Loading

iloveagent57 commented Jan 23, 2024 •

edited

Loading